/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.persistence.hibernate.bean.impl;

import com.genia.toolbox.basics.bean.DisplayObject;
import com.genia.toolbox.basics.manager.CollectionManager;
import com.genia.toolbox.persistence.hibernate.bean.Queryable;
import com.genia.toolbox.persistence.hibernate.criteria.HibernateCriteria;

/**
 * This class reuse <code>appendQuery</code> on a <code>Queryable</code> to
 * recursively generates a query.
 */
public class QueryableDisplayObject
    implements DisplayObject<Queryable>
{

  /**
   * the code <code>CollectionManager</code> that allow to perform joins.
   */
  private final transient CollectionManager collectionManager;

  /**
   * the <code>HibernateCriteria</code> for which the query is generated.
   */
  private final transient HibernateCriteria<?> criteria;

  /**
   * can this part of the query use named parameters?
   */
  private final transient boolean canHaveParameter;



  /**
   * Constructor.
   * 
   * @param canHaveParameter
   *          can this part of the query use named parameters?
   * @param collectionManager
   *          the code <code>CollectionManager</code> that allow to perform
   *          joins
   * @param criteria
   *          the <code>HibernateCriteria</code> for which the query is
   *          generated
   */
  public QueryableDisplayObject(final boolean canHaveParameter, final CollectionManager collectionManager, final HibernateCriteria<?> criteria)
  {
    this.canHaveParameter = canHaveParameter;
    this.collectionManager = collectionManager;
    this.criteria = criteria;
  }



  /**
   * append the <code>String</code> representation of <code>object</code> to
   * <code>appendable</code>.
   * 
   * @param appendable
   *          the <code>Appendable</code> that will get the representation of
   *          <code>objetct</code>
   * @param queryable
   *          the object to be represented
   */
  public void append(final Appendable appendable, final Queryable queryable)
  {
    queryable.appendQuery(canHaveParameter, collectionManager, criteria, (StringBuilder) appendable, this);
  }

}
